home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xvc / XSGIvcSetPlatformParameter.z / XSGIvcSetPlatformParameter
Encoding:
Text File  |  1998-10-30  |  8.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))       XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSGIvcSetPlatformParameter, XSGIvcQueryPlatformParameter -
  10.           Set and query a video parameter unique to a graphics
  11.           platform
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>>
  15.  
  16.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  17.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  18.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  19.               iiiinnnntttt ppppaaaarrrraaaammmmeeeetttteeeerrrrIIIIDDDD,,,,
  20.               vvvvooooiiiidddd ****ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk,,,,
  21.               iiiinnnntttt ssssiiiizzzzeeeeooooffffPPPPaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk))))
  22.  
  23.           SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  24.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  25.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  26.               iiiinnnntttt ppppaaaarrrraaaammmmeeeetttteeeerrrrIIIIDDDD,,,,
  27.               vvvvooooiiiidddd ****ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk,,,,
  28.               iiiinnnntttt ssssiiiizzzzeeeeooooffffPPPPaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk))))
  29.  
  30.      PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  31.           _d_i_s_p_l_a_y                Specifies the connection to the X
  32.                                  server.
  33.  
  34.           _s_c_r_e_e_n                 Specifies the screen of the X server.
  35.  
  36.           _c_h_a_n_n_e_l                Specifies the channel number.
  37.  
  38.           _p_a_r_a_m_e_t_e_r_I_D            Specifies which parameter is to be
  39.                                  affected or queried.  The parameterID
  40.                                  is unique only to a graphics hardware
  41.                                  platform; the same parameterID may be
  42.                                  used by different hardware platforms
  43.                                  to define different operations.
  44.  
  45.           _p_a_r_a_m_e_t_e_r_B_l_o_c_k         A pointer to the parameter block to
  46.                                  be used for the operation.
  47.  
  48.           _s_i_z_e_o_f_P_a_r_a_m_e_t_e_r_B_l_o_c_k   The size of the parameter block for
  49.                                  this parameter.  The size must match
  50.                                  the size expected for this
  51.                                  parameterID.
  52.  
  53.  
  54.  
  55.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  56.           Some graphics hardware platforms may offer controls that are
  57.           not supported across the entire range of Silicon GraphicsTM
  58.           machines, but instead are unique to a certain graphics
  59.           hardware platform.  In this circumstance, you may affect the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))       XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
  71.  
  72.  
  73.  
  74.           control via XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr.
  75.  
  76.           Each hardware platform may optionally offer one or more
  77.           platform-specific control parameters.  Because these are
  78.           unique, these parameters are described in the documentation
  79.           accompanying the hardware.  Each parameter has a different
  80.           parameter block associated with it.  The constitution of the
  81.           ppppaaaarrrraaaammmmeeeetttteeeerrrrBBBBlllloooocccckkkk is defined by a structure provided by an
  82.           included file that accompanies the hardware platform.
  83.  
  84.           You may retrieve the value of the parameter by calling
  85.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr which fills the parameter block
  86.           with the current values of the control parameter.
  87.  
  88.           Note that if you use platform-specific control parameters,
  89.           you are affecting a control used on only one platform.  The
  90.           control is not guaranteed to operate on any other platform
  91.           than the one on which the control parameter is designated.
  92.  
  93.  
  94.      EEEEVVVVEEEENNNNTTTTSSSS
  95.           When this control is altered, the server generates a
  96.           PlatformParamNotify event.
  97.  
  98.  
  99.      RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  100.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr returns TRUE if successful,
  101.           FALSE upon failure.
  102.  
  103.           Parameter errors are reported via BadValue or BadMatch.
  104.  
  105.  
  106.  
  107.      EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  108.           In the following contrived example, the graphics hardware
  109.           platform called NewPlatform contains the following
  110.           definitions to describe a parameter control named IOCUS
  111.           whose type is integer.  The definitions might be contained
  112.           in a file named XSGIvcNewPlatform.h and might include:
  113.  
  114.           #define IOCUS_PARAMETER 5
  115.           #define IOCUS_MIN 0
  116.           #define IOCUS_MAX 32
  117.  
  118.           typedef struct _iocus {
  119.               int       value;
  120.           }    iocus_t;
  121.  
  122.           To use the IOCUS control parameter, call the
  123.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr function; the following example
  124.           sets the value to its lowest value.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))       XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttPPPPllllaaaattttffffoooorrrrmmmmPPPPaaaarrrraaaammmmeeeetttteeeerrrr((((3333))))
  137.  
  138.  
  139.  
  140.           #include <X11/extensions/XSGIvc.h>
  141.           #include <XSGIvcNewPlatform.h>
  142.  
  143.           iocus_t     parameterBlock;
  144.           int         channel = 2;
  145.  
  146.           parameterBlock.value = IOCUS_MIN;
  147.  
  148.           XSGIvcSetPlatformParameter(dpy,
  149.               screen,
  150.               channel,
  151.               IOCUS_PARAMETER,
  152.               ¶meterBlock,
  153.               sizeof(parameterBlock));
  154.  
  155.  
  156.  
  157.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  158.           XSGIvc
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.